home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / sormrz.z / sormrz
Encoding:
Text File  |  2002-10-03  |  5.6 KB  |  199 lines

  1.  
  2.  
  3.  
  4. SSSSOOOORRRRMMMMRRRRZZZZ((((3333SSSS))))                                                          SSSSOOOORRRRMMMMRRRRZZZZ((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SORMRZ - overwrite the general real M-by-N matrix C with  SIDE = 'L' SIDE
  10.      = 'R' TRANS = 'N'
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE SORMRZ( SIDE, TRANS, M, N, K, L, A, LDA, TAU, C, LDC, WORK,
  14.                         LWORK, INFO )
  15.  
  16.          CHARACTER      SIDE, TRANS
  17.  
  18.          INTEGER        INFO, K, L, LDA, LDC, LWORK, M, N
  19.  
  20.          REAL           A( LDA, * ), C( LDC, * ), TAU( * ), WORK( * )
  21.  
  22. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  23.      These routines are part of the SCSL Scientific Library and can be loaded
  24.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  25.      directs the linker to use the multi-processor version of the library.
  26.  
  27.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  28.      4 bytes (32 bits). Another version of SCSL is available in which integers
  29.      are 8 bytes (64 bits).  This version allows the user access to larger
  30.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  31.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  32.      only one of the two versions; 4-byte integer and 8-byte integer library
  33.      calls cannot be mixed.
  34.  
  35. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  36.      SORMRZ overwrites the general real M-by-N matrix C with SIDE = 'L' SIDE =
  37.      'R' TRANS = 'N': Q * C C * Q TRANS = 'T':      Q**T * C       C * Q**T
  38.  
  39.      where Q is a real orthogonal matrix defined as the product of k
  40.      elementary reflectors
  41.  
  42.            Q = H(1) H(2) . . . H(k)
  43.  
  44.      as returned by STZRZF. Q is of order M if SIDE = 'L' and of order N if
  45.      SIDE = 'R'.
  46.  
  47.  
  48. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  49.      SIDE    (input) CHARACTER*1
  50.              = 'L': apply Q or Q**T from the Left;
  51.              = 'R': apply Q or Q**T from the Right.
  52.  
  53.      TRANS   (input) CHARACTER*1
  54.              = 'N':  No transpose, apply Q;
  55.              = 'T':  Transpose, apply Q**T.
  56.  
  57.      M       (input) INTEGER
  58.              The number of rows of the matrix C. M >= 0.
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSOOOORRRRMMMMRRRRZZZZ((((3333SSSS))))                                                          SSSSOOOORRRRMMMMRRRRZZZZ((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      N       (input) INTEGER
  75.              The number of columns of the matrix C. N >= 0.
  76.  
  77.      K       (input) INTEGER
  78.              The number of elementary reflectors whose product defines the
  79.              matrix Q.  If SIDE = 'L', M >= K >= 0; if SIDE = 'R', N >= K >=
  80.              0.
  81.  
  82.      L       (input) INTEGER
  83.              The number of columns of the matrix A containing the meaningful
  84.              part of the Householder reflectors.  If SIDE = 'L', M >= L >= 0,
  85.              if SIDE = 'R', N >= L >= 0.
  86.  
  87.      A       (input) REAL array, dimension
  88.              (LDA,M) if SIDE = 'L', (LDA,N) if SIDE = 'R' The i-th row must
  89.              contain the vector which defines the elementary reflector H(i),
  90.              for i = 1,2,...,k, as returned by STZRZF in the last k rows of
  91.              its array argument A.  A is modified by the routine but restored
  92.              on exit.
  93.  
  94.      LDA     (input) INTEGER
  95.              The leading dimension of the array A. LDA >= max(1,K).
  96.  
  97.      TAU     (input) REAL array, dimension (K)
  98.              TAU(i) must contain the scalar factor of the elementary reflector
  99.              H(i), as returned by STZRZF.
  100.  
  101.      C       (input/output) REAL array, dimension (LDC,N)
  102.              On entry, the M-by-N matrix C.  On exit, C is overwritten by Q*C
  103.              or Q**H*C or C*Q**H or C*Q.
  104.  
  105.      LDC     (input) INTEGER
  106.              The leading dimension of the array C. LDC >= max(1,M).
  107.  
  108.      WORK    (workspace/output) REAL array, dimension (LWORK)
  109.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
  110.  
  111.      LWORK   (input) INTEGER
  112.              The dimension of the array WORK.  If SIDE = 'L', LWORK >=
  113.              max(1,N); if SIDE = 'R', LWORK >= max(1,M).  For optimum
  114.              performance LWORK >= N*NB if SIDE = 'L', and LWORK >= M*NB if
  115.              SIDE = 'R', where NB is the optimal blocksize.
  116.  
  117.              If LWORK = -1, then a workspace query is assumed; the routine
  118.              only calculates the optimal size of the WORK array, returns this
  119.              value as the first entry of the WORK array, and no error message
  120.              related to LWORK is issued by XERBLA.
  121.  
  122.      INFO    (output) INTEGER
  123.              = 0:  successful exit
  124.              < 0:  if INFO = -i, the i-th argument had an illegal value
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSOOOORRRRMMMMRRRRZZZZ((((3333SSSS))))                                                          SSSSOOOORRRRMMMMRRRRZZZZ((((3333SSSS))))
  137.  
  138.  
  139.  
  140. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  141.      Based on contributions by
  142.        A. Petitet, Computer Science Dept., Univ. of Tenn., Knoxville, USA
  143.  
  144.  
  145. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  146.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  147.  
  148.      This man page is available only online.
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.